<!DOCTYPE html>
<html lang="en-US">
<head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="language" content="en" />
        <link href="./assets/ffd55088/css/bootstrap.css" rel="stylesheet">
<link href="./assets/5cf9384a/solarized_light.css" rel="stylesheet">
<link href="./assets/6c54116e/style.css" rel="stylesheet">
<script src="./assets/a44cef0f/jquery.js"></script>
<script src="./assets/ffd55088/js/bootstrap.js"></script>
<script src="./assets/8ac4e28a/jssearch.js"></script>    <title>Command, yii\sphinx\Command - Yii Framework 2.0 API Documentation</title>
</head>
<body>

<div class="wrap">
    <nav id="w12033" class="navbar-inverse navbar-fixed-top navbar" role="navigation"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#w12033-collapse"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span></button><a class="navbar-brand" href="./index.html">Yii Framework 2.0 API Documentation</a></div><div id="w12033-collapse" class="collapse navbar-collapse"><ul id="w12034" class="navbar-nav nav"><li><a href="./index.html">Class reference</a></li>
<li class="dropdown"><a class="dropdown-toggle" href="#" data-toggle="dropdown">Extensions <b class="caret"></b></a><ul id="w12035" class="dropdown-menu"><li><a href="./ext-apidoc-index.html" tabindex="-1">apidoc</a></li>
<li><a href="./ext-authclient-index.html" tabindex="-1">authclient</a></li>
<li><a href="./ext-bootstrap-index.html" tabindex="-1">bootstrap</a></li>
<li><a href="./ext-codeception-index.html" tabindex="-1">codeception</a></li>
<li><a href="./ext-debug-index.html" tabindex="-1">debug</a></li>
<li><a href="./ext-elasticsearch-index.html" tabindex="-1">elasticsearch</a></li>
<li><a href="./ext-faker-index.html" tabindex="-1">faker</a></li>
<li><a href="./ext-gii-index.html" tabindex="-1">gii</a></li>
<li><a href="./ext-imagine-index.html" tabindex="-1">imagine</a></li>
<li><a href="./ext-jui-index.html" tabindex="-1">jui</a></li>
<li><a href="./ext-mongodb-index.html" tabindex="-1">mongodb</a></li>
<li><a href="./ext-redis-index.html" tabindex="-1">redis</a></li>
<li><a href="./ext-smarty-index.html" tabindex="-1">smarty</a></li>
<li><a href="./ext-sphinx-index.html" tabindex="-1">sphinx</a></li>
<li><a href="./ext-swiftmailer-index.html" tabindex="-1">swiftmailer</a></li>
<li><a href="./ext-twig-index.html" tabindex="-1">twig</a></li></ul></li>
<li><a href="./guide-README.html">Guide</a></li></ul><div class="navbar-form navbar-left" role="search">
  <div class="form-group">
    <input id="searchbox" type="text" class="form-control" placeholder="Search">
  </div>
</div>
</div></nav>
    <div id="search-resultbox" style="display: none;" class="modal-content">
        <ul id="search-results">
        </ul>
    </div>

    
<div class="row">
    <div class="col-md-3">
                <div id="navigation" class="list-group"><a class="list-group-item active" href="#navigation-12031" data-toggle="collapse" data-parent="#navigation">yii\sphinx <b class="caret"></b></a><div id="navigation-12031" class="submenu panel-collapse collapse in"><a class="list-group-item" href="./yii-sphinx-activedataprovider.html">ActiveDataProvider</a>
<a class="list-group-item" href="./yii-sphinx-activefixture.html">ActiveFixture</a>
<a class="list-group-item" href="./yii-sphinx-activequery.html">ActiveQuery</a>
<a class="list-group-item" href="./yii-sphinx-activerecord.html">ActiveRecord</a>
<a class="list-group-item" href="./yii-sphinx-columnschema.html">ColumnSchema</a>
<a class="list-group-item active" href="./yii-sphinx-command.html">Command</a>
<a class="list-group-item" href="./yii-sphinx-connection.html">Connection</a>
<a class="list-group-item" href="./yii-sphinx-indexschema.html">IndexSchema</a>
<a class="list-group-item" href="./yii-sphinx-query.html">Query</a>
<a class="list-group-item" href="./yii-sphinx-querybuilder.html">QueryBuilder</a>
<a class="list-group-item" href="./yii-sphinx-schema.html">Schema</a></div>
<a class="list-group-item" href="#navigation-12032" data-toggle="collapse" data-parent="#navigation">yii\sphinx\gii\model <b class="caret"></b></a><div id="navigation-12032" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-sphinx-gii-model-generator.html">Generator</a></div></div>    </div>
    <div class="col-md-9 api-content" role="main">
        <h1>Class yii\sphinx\Command</h1>
<div class="top-nav">
    <a href="index.html">All Classes</a>
            | <a href="#properties">Properties</a>
                | <a href="#methods">Methods</a>
            </div>

<table class="summaryTable docClass table table-bordered">
    <colgroup>
        <col class="col-name" />
        <col class="col-value" />
    </colgroup>
            <tr><th>Inheritance</th><td><a href="yii-sphinx-command.html">yii\sphinx\Command</a> &raquo;
<a href="yii-db-command.html">yii\db\Command</a> &raquo;
<a href="yii-base-component.html">yii\base\Component</a> &raquo;
<a href="yii-base-object.html">yii\base\Object</a></td></tr>
                <tr><th>Implements</th><td><a href="yii-base-configurable.html">yii\base\Configurable</a></td></tr>
                                    <tr><th>Available since version</th><td>2.0</td></tr>
                    <tr>
          <th>Source Code</th>
          <td><a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php">https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php</a></td>
        </tr>
    </table>

<div class="class-description">
    <p><strong>Command represents a SQL statement to be executed against a Sphinx.</strong></p>
    <p>A command object is usually created by calling <a href="yii-sphinx-connection.html#createCommand()-detail">yii\sphinx\Connection::createCommand()</a>.
The SQL statement it represents can be set via the <a href="yii-db-command.html#$sql-detail">$sql</a> property.</p>
<p>To execute a non-query SQL (such as INSERT, REPLACE, DELETE, UPDATE), call <a href="yii-db-command.html#execute()-detail">execute()</a>.
To execute a SQL statement that returns result data set (such as SELECT, CALL SNIPPETS, CALL KEYWORDS),
use <a href="yii-db-command.html#queryAll()-detail">queryAll()</a>, <a href="yii-db-command.html#queryOne()-detail">queryOne()</a>, <a href="yii-db-command.html#queryColumn()-detail">queryColumn()</a>, <a href="yii-db-command.html#queryScalar()-detail">queryScalar()</a>, or <a href="yii-db-command.html#query()-detail">query()</a>.
For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$articles</span> = <span class="hljs-variable">$connection</span>-&gt;createCommand(<span class="hljs-string">"SELECT * FROM `idx_article` WHERE MATCH('programming')"</span>)-&gt;queryAll();
</code></pre>
<p>Command supports SQL statement preparation and parameter binding just as <a href="yii-db-command.html">yii\db\Command</a> does.</p>
<p>Command also supports building SQL statements by providing methods such as <a href="yii-db-command.html#insert()-detail">insert()</a>,
<a href="yii-sphinx-command.html#update()-detail">update()</a>, etc. For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$connection</span>-&gt;createCommand()-&gt;update(<span class="hljs-string">'idx_article'</span>, [
    <span class="hljs-string">'genre_id'</span> =&gt; <span class="hljs-number">15</span>,
    <span class="hljs-string">'author_id'</span> =&gt; <span class="hljs-number">157</span>,
])-&gt;execute();
</code></pre>
<p>To build SELECT SQL statements, please use <a href="yii-sphinx-query.html">yii\sphinx\Query</a> and <a href="yii-sphinx-querybuilder.html">yii\sphinx\QueryBuilder</a> instead.</p>

    </div>

<a id="properties"></a>

<div class="summary doc-property">
<h2>Public Properties</h2>

<p><a href="#" class="toggle">Hide inherited properties</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-property" />
    <col class="col-type" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Property</th><th>Type</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="$behaviors">
        <td><a href="yii-base-component.html#$behaviors-detail">$behaviors</a></td>
        <td><a href="yii-base-behavior.html">yii\base\Behavior</a>[]</td>
        <td>List of behaviors attached to this component</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="$db">
        <td><a href="yii-sphinx-command.html#$db-detail">$db</a></td>
        <td><a href="yii-sphinx-connection.html">yii\sphinx\Connection</a></td>
        <td>The Sphinx connection that this command is associated with.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr class="inherited" id="$fetchMode">
        <td><a href="yii-db-command.html#$fetchMode-detail">$fetchMode</a></td>
        <td><a href="http://www.php.net/language.types.integer">integer</a></td>
        <td>The default fetch mode for this command.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="$params">
        <td><a href="yii-db-command.html#$params-detail">$params</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The parameters (name =&gt; value) that are bound to the current PDO statement.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="$pdoStatement">
        <td><a href="yii-db-command.html#$pdoStatement-detail">$pdoStatement</a></td>
        <td><a href="http://www.php.net/class.pdostatement">PDOStatement</a></td>
        <td>The PDOStatement object that this command is associated with</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="$queryCacheDependency">
        <td><a href="yii-db-command.html#$queryCacheDependency-detail">$queryCacheDependency</a></td>
        <td><a href="yii-caching-dependency.html">yii\caching\Dependency</a></td>
        <td>The dependency to be associated with the cached query result for this command</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="$queryCacheDuration">
        <td><a href="yii-db-command.html#$queryCacheDuration-detail">$queryCacheDuration</a></td>
        <td><a href="http://www.php.net/language.types.integer">integer</a></td>
        <td>The default number of seconds that query results can remain valid in cache.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="$rawSql">
        <td><a href="yii-db-command.html#$rawSql-detail">$rawSql</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The raw SQL with parameter values inserted into the corresponding placeholders in <a href="yii-db-command.html#$sql-detail">$sql</a>.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="$sql">
        <td><a href="yii-db-command.html#$sql-detail">$sql</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The SQL statement to be executed</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
    </table>
</div>

<a id="methods"></a>

<div class="summary doc-method">
<h2>Public Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="__call()">
        <td><a href="yii-base-component.html#__call()-detail">__call()</a></td>
        <td>Calls the named method which is not a class method.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__clone()">
        <td><a href="yii-base-component.html#__clone()-detail">__clone()</a></td>
        <td>This method is called after the object is created by cloning an existing one.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__construct()">
        <td><a href="yii-base-object.html#__construct()-detail">__construct()</a></td>
        <td>Constructor.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__get()">
        <td><a href="yii-base-component.html#__get()-detail">__get()</a></td>
        <td>Returns the value of a component property.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__isset()">
        <td><a href="yii-base-component.html#__isset()-detail">__isset()</a></td>
        <td>Checks if a property is set, i.e. defined and not null.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__set()">
        <td><a href="yii-base-component.html#__set()-detail">__set()</a></td>
        <td>Sets the value of a component property.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__unset()">
        <td><a href="yii-base-component.html#__unset()-detail">__unset()</a></td>
        <td>Sets a component property to be null.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="addColumn()">
        <td><a href="yii-sphinx-command.html#addColumn()-detail">addColumn()</a></td>
        <td>Creates a SQL command for adding a new DB column.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr class="inherited" id="addCommentOnColumn()">
        <td><a href="yii-db-command.html#addCommentOnColumn()-detail">addCommentOnColumn()</a></td>
        <td>Builds a SQL command for adding comment to column</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="addCommentOnTable()">
        <td><a href="yii-db-command.html#addCommentOnTable()-detail">addCommentOnTable()</a></td>
        <td>Builds a SQL command for adding comment to table</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr id="addForeignKey()">
        <td><a href="yii-sphinx-command.html#addForeignKey()-detail">addForeignKey()</a></td>
        <td>Creates a SQL command for adding a foreign key constraint to an existing table.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="addPrimaryKey()">
        <td><a href="yii-sphinx-command.html#addPrimaryKey()-detail">addPrimaryKey()</a></td>
        <td>Creates a SQL command for adding a primary key constraint to an existing table.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="alterColumn()">
        <td><a href="yii-sphinx-command.html#alterColumn()-detail">alterColumn()</a></td>
        <td>Creates a SQL command for changing the definition of a column.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr class="inherited" id="attachBehavior()">
        <td><a href="yii-base-component.html#attachBehavior()-detail">attachBehavior()</a></td>
        <td>Attaches a behavior to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="attachBehaviors()">
        <td><a href="yii-base-component.html#attachBehaviors()-detail">attachBehaviors()</a></td>
        <td>Attaches a list of behaviors to the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="batchInsert()">
        <td><a href="yii-sphinx-command.html#batchInsert()-detail">batchInsert()</a></td>
        <td>Creates a batch INSERT command.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="batchReplace()">
        <td><a href="yii-sphinx-command.html#batchReplace()-detail">batchReplace()</a></td>
        <td>Creates a batch REPLACE command.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr class="inherited" id="behaviors()">
        <td><a href="yii-base-component.html#behaviors()-detail">behaviors()</a></td>
        <td>Returns a list of behaviors that this component should behave as.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="bindParam()">
        <td><a href="yii-db-command.html#bindParam()-detail">bindParam()</a></td>
        <td>Binds a parameter to the SQL statement to be executed.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
                <tr class="inherited" id="bindValue()">
        <td><a href="yii-db-command.html#bindValue()-detail">bindValue()</a></td>
        <td>Binds a value to a parameter.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="bindValues()">
        <td><a href="yii-db-command.html#bindValues()-detail">bindValues()</a></td>
        <td>Binds a list of values to the corresponding parameters.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="cache()">
        <td><a href="yii-db-command.html#cache()-detail">cache()</a></td>
        <td>Enables query cache for this command.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr id="callKeywords()">
        <td><a href="yii-sphinx-command.html#callKeywords()-detail">callKeywords()</a></td>
        <td>Returns tokenized and normalized forms of the keywords, and, optionally, keyword statistics.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="callSnippets()">
        <td><a href="yii-sphinx-command.html#callSnippets()-detail">callSnippets()</a></td>
        <td>Builds a snippet from provided data and query, using specified index settings.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr class="inherited" id="canGetProperty()">
        <td><a href="yii-base-component.html#canGetProperty()-detail">canGetProperty()</a></td>
        <td>Returns a value indicating whether a property can be read.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="canSetProperty()">
        <td><a href="yii-base-component.html#canSetProperty()-detail">canSetProperty()</a></td>
        <td>Returns a value indicating whether a property can be set.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="cancel()">
        <td><a href="yii-db-command.html#cancel()-detail">cancel()</a></td>
        <td>Cancels the execution of the SQL statement.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr id="checkIntegrity()">
        <td><a href="yii-sphinx-command.html#checkIntegrity()-detail">checkIntegrity()</a></td>
        <td>Builds a SQL command for enabling or disabling integrity check.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr class="inherited" id="className()">
        <td><a href="yii-base-object.html#className()-detail">className()</a></td>
        <td>Returns the fully qualified name of this class.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr id="createIndex()">
        <td><a href="yii-sphinx-command.html#createIndex()-detail">createIndex()</a></td>
        <td>Creates a SQL command for creating a new index.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="createTable()">
        <td><a href="yii-sphinx-command.html#createTable()-detail">createTable()</a></td>
        <td>Creates a SQL command for creating a new DB table.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr class="inherited" id="delete()">
        <td><a href="yii-db-command.html#delete()-detail">delete()</a></td>
        <td>Creates a DELETE command.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="detachBehavior()">
        <td><a href="yii-base-component.html#detachBehavior()-detail">detachBehavior()</a></td>
        <td>Detaches a behavior from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="detachBehaviors()">
        <td><a href="yii-base-component.html#detachBehaviors()-detail">detachBehaviors()</a></td>
        <td>Detaches all behaviors from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="dropColumn()">
        <td><a href="yii-sphinx-command.html#dropColumn()-detail">dropColumn()</a></td>
        <td>Creates a SQL command for dropping a DB column.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr class="inherited" id="dropCommentFromColumn()">
        <td><a href="yii-db-command.html#dropCommentFromColumn()-detail">dropCommentFromColumn()</a></td>
        <td>Builds a SQL command for dropping comment from column</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="dropCommentFromTable()">
        <td><a href="yii-db-command.html#dropCommentFromTable()-detail">dropCommentFromTable()</a></td>
        <td>Builds a SQL command for dropping comment from table</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr id="dropForeignKey()">
        <td><a href="yii-sphinx-command.html#dropForeignKey()-detail">dropForeignKey()</a></td>
        <td>Creates a SQL command for dropping a foreign key constraint.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="dropIndex()">
        <td><a href="yii-sphinx-command.html#dropIndex()-detail">dropIndex()</a></td>
        <td>Creates a SQL command for dropping an index.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="dropPrimaryKey()">
        <td><a href="yii-sphinx-command.html#dropPrimaryKey()-detail">dropPrimaryKey()</a></td>
        <td>Creates a SQL command for removing a primary key constraint to an existing table.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="dropTable()">
        <td><a href="yii-sphinx-command.html#dropTable()-detail">dropTable()</a></td>
        <td>Creates a SQL command for dropping a DB table.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr class="inherited" id="ensureBehaviors()">
        <td><a href="yii-base-component.html#ensureBehaviors()-detail">ensureBehaviors()</a></td>
        <td>Makes sure that the behaviors declared in <a href="yii-base-component.html#behaviors()-detail">behaviors()</a> are attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="execute()">
        <td><a href="yii-db-command.html#execute()-detail">execute()</a></td>
        <td>Executes the SQL statement.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="getBehavior()">
        <td><a href="yii-base-component.html#getBehavior()-detail">getBehavior()</a></td>
        <td>Returns the named behavior object.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getBehaviors()">
        <td><a href="yii-base-component.html#getBehaviors()-detail">getBehaviors()</a></td>
        <td>Returns all behaviors attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getRawSql()">
        <td><a href="yii-db-command.html#getRawSql()-detail">getRawSql()</a></td>
        <td>Returns the raw SQL by inserting parameter values into the corresponding placeholders in <a href="yii-db-command.html#$sql-detail">$sql</a>.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="getSql()">
        <td><a href="yii-db-command.html#getSql()-detail">getSql()</a></td>
        <td>Returns the SQL statement for this command.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="hasEventHandlers()">
        <td><a href="yii-base-component.html#hasEventHandlers()-detail">hasEventHandlers()</a></td>
        <td>Returns a value indicating whether there is any handler attached to the named event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasMethod()">
        <td><a href="yii-base-component.html#hasMethod()-detail">hasMethod()</a></td>
        <td>Returns a value indicating whether a method is defined.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasProperty()">
        <td><a href="yii-base-component.html#hasProperty()-detail">hasProperty()</a></td>
        <td>Returns a value indicating whether a property is defined for this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="init()">
        <td><a href="yii-base-object.html#init()-detail">init()</a></td>
        <td>Initializes the object.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="insert()">
        <td><a href="yii-db-command.html#insert()-detail">insert()</a></td>
        <td>Creates an INSERT command.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="noCache()">
        <td><a href="yii-db-command.html#noCache()-detail">noCache()</a></td>
        <td>Disables query cache for this command.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="off()">
        <td><a href="yii-base-component.html#off()-detail">off()</a></td>
        <td>Detaches an existing event handler from this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="on()">
        <td><a href="yii-base-component.html#on()-detail">on()</a></td>
        <td>Attaches an event handler to an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="prepare()">
        <td><a href="yii-db-command.html#prepare()-detail">prepare()</a></td>
        <td>Prepares the SQL statement to be executed.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="query()">
        <td><a href="yii-db-command.html#query()-detail">query()</a></td>
        <td>Executes the SQL statement and returns query result.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="queryAll()">
        <td><a href="yii-db-command.html#queryAll()-detail">queryAll()</a></td>
        <td>Executes the SQL statement and returns ALL rows at once.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="queryColumn()">
        <td><a href="yii-db-command.html#queryColumn()-detail">queryColumn()</a></td>
        <td>Executes the SQL statement and returns the first column of the result.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
                <tr class="inherited" id="queryOne()">
        <td><a href="yii-db-command.html#queryOne()-detail">queryOne()</a></td>
        <td>Executes the SQL statement and returns the first row of the result.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="queryScalar()">
        <td><a href="yii-db-command.html#queryScalar()-detail">queryScalar()</a></td>
        <td>Executes the SQL statement and returns the value of the first column in the first row of data.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
                <tr id="renameColumn()">
        <td><a href="yii-sphinx-command.html#renameColumn()-detail">renameColumn()</a></td>
        <td>Creates a SQL command for renaming a column.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="renameTable()">
        <td><a href="yii-sphinx-command.html#renameTable()-detail">renameTable()</a></td>
        <td>Creates a SQL command for renaming a DB table.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="replace()">
        <td><a href="yii-sphinx-command.html#replace()-detail">replace()</a></td>
        <td>Creates an REPLACE command.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
                <tr id="resetSequence()">
        <td><a href="yii-sphinx-command.html#resetSequence()-detail">resetSequence()</a></td>
        <td>Creates a SQL command for resetting the sequence value of a table's primary key.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr class="inherited" id="setSql()">
        <td><a href="yii-db-command.html#setSql()-detail">setSql()</a></td>
        <td>Specifies the SQL statement to be executed.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
            <tr class="inherited" id="trigger()">
        <td><a href="yii-base-component.html#trigger()-detail">trigger()</a></td>
        <td>Triggers an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="truncateIndex()">
        <td><a href="yii-sphinx-command.html#truncateIndex()-detail">truncateIndex()</a></td>
        <td>Creates a SQL command for truncating a runtime index.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="truncateTable()">
        <td><a href="yii-sphinx-command.html#truncateTable()-detail">truncateTable()</a></td>
        <td>Creates a SQL command for truncating a DB table.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
            <tr id="update()">
        <td><a href="yii-sphinx-command.html#update()-detail">update()</a></td>
        <td>Creates an UPDATE command.</td>
        <td><a href="yii-sphinx-command.html">yii\sphinx\Command</a></td>
    </tr>
    </table>
</div>

<div class="summary doc-method">
<h2>Protected Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
                                                                                    <tr class="inherited" id="bindPendingParams()">
        <td><a href="yii-db-command.html#bindPendingParams()-detail">bindPendingParams()</a></td>
        <td>Binds pending parameters that were registered via <a href="yii-db-command.html#bindValue()-detail">bindValue()</a> and <a href="yii-db-command.html#bindValues()-detail">bindValues()</a>.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
                                                                                                                                                                            <tr class="inherited" id="queryInternal()">
        <td><a href="yii-db-command.html#queryInternal()-detail">queryInternal()</a></td>
        <td>Performs the actual DB query of a SQL statement.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
                    <tr class="inherited" id="refreshTableSchema()">
        <td><a href="yii-db-command.html#refreshTableSchema()-detail">refreshTableSchema()</a></td>
        <td>Refreshes table schema, which was marked by <a href="yii-db-command.html#requireTableSchemaRefresh()-detail">requireTableSchemaRefresh()</a></td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
                        <tr class="inherited" id="requireTableSchemaRefresh()">
        <td><a href="yii-db-command.html#requireTableSchemaRefresh()-detail">requireTableSchemaRefresh()</a></td>
        <td>Marks a specified table schema to be refreshed after command execution.</td>
        <td><a href="yii-db-command.html">yii\db\Command</a></td>
    </tr>
                            </table>
</div>

<a id="events"></a>

<a id="constants"></a>

<h2>Property Details</h2>

<div class="property-doc">

    <div class="detail-header h3" id="$db-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#$db-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L50" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L50" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $db        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>The Sphinx connection that this command is associated with.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-connection.html">yii\sphinx\Connection</a></span> <a href="yii-sphinx-command.html#$db-detail">$db</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>

</div>
<h2>Method Details</h2>

<div class="method-doc">

    <div class="detail-header h3" id="addColumn()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#addColumn()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L242" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L242" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        addColumn()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for adding a new DB column.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#addColumn()-detail">addColumn</a></strong> ( <span style="color: #0000BB">$table</span>, <span style="color: #0000BB">$column</span>, <span style="color: #0000BB">$type</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table that the new column will be added to. The table name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$column</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the new column. The name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$type</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The column type. <a href="yii-db-querybuilder.html#getColumnType()-detail">yii\db\QueryBuilder::getColumnType()</a> will be called
to convert the give column type to the physical one. For example, <code>string</code> will be converted
as <code>varchar(255)</code>, and <code>string not null</code> becomes <code>varchar(255) not null</code>.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="addForeignKey()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#addForeignKey()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L290" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L290" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        addForeignKey()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for adding a foreign key constraint to an existing table.</strong></p>

        <p>The method will properly quote the table and column names.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#addForeignKey()-detail">addForeignKey</a></strong> ( <span style="color: #0000BB">$name</span>, <span style="color: #0000BB">$table</span>, <span style="color: #0000BB">$columns</span>, <span style="color: #0000BB">$refTable</span>, <span style="color: #0000BB">$refColumns</span>, <span style="color: #0000BB">$delete&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span>, <span style="color: #0000BB">$update&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$name</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the foreign key constraint.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table that the foreign key constraint will be added to.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$refTable</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table that the foreign key references to.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$refColumns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The name of the column that the foreign key references to. If there are multiple columns, separate them with commas.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$delete</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$update</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="addPrimaryKey()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#addPrimaryKey()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L274" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L274" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        addPrimaryKey()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for adding a primary key constraint to an existing table.</strong></p>

        <p>The method will properly quote the table and column names.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#addPrimaryKey()-detail">addPrimaryKey</a></strong> ( <span style="color: #0000BB">$name</span>, <span style="color: #0000BB">$table</span>, <span style="color: #0000BB">$columns</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$name</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the primary key constraint.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table that the primary key constraint will be added to.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Comma separated string or array of columns that the primary key will consist of.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="alterColumn()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#alterColumn()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L266" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L266" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        alterColumn()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for changing the definition of a column.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#alterColumn()-detail">alterColumn</a></strong> ( <span style="color: #0000BB">$table</span>, <span style="color: #0000BB">$column</span>, <span style="color: #0000BB">$type</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table whose column is to be changed. The table name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$column</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the column to be changed. The name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$type</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The column type. <a href="yii-db-querybuilder.html#getColumnType()-detail">yii\db\QueryBuilder::getColumnType()</a> will be called
to convert the give column type to the physical one. For example, <code>string</code> will be converted
as <code>varchar(255)</code>, and <code>string not null</code> becomes <code>varchar(255) not null</code>.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="batchInsert()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#batchInsert()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L72" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L72" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        batchInsert()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a batch INSERT command.</strong></p>

        <p>For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$connection</span>-&gt;createCommand()-&gt;batchInsert(<span class="hljs-string">'idx_user'</span>, [<span class="hljs-string">'name'</span>, <span class="hljs-string">'age'</span>], [
    [<span class="hljs-string">'Tom'</span>, <span class="hljs-number">30</span>],
    [<span class="hljs-string">'Jane'</span>, <span class="hljs-number">20</span>],
    [<span class="hljs-string">'Linda'</span>, <span class="hljs-number">25</span>],
])-&gt;execute();
</code></pre>
<p>Note that the values in each row must match the corresponding column names.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#batchInsert()-detail">batchInsert</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$columns</span>, <span style="color: #0000BB">$rows</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index that new rows will be inserted into.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column names</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$rows</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The rows to be batch inserted into the index</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="batchReplace()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#batchReplace()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L126" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L126" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        batchReplace()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a batch REPLACE command.</strong></p>

        <p>For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$connection</span>-&gt;createCommand()-&gt;batchReplace(<span class="hljs-string">'idx_user'</span>, [<span class="hljs-string">'name'</span>, <span class="hljs-string">'age'</span>], [
    [<span class="hljs-string">'Tom'</span>, <span class="hljs-number">30</span>],
    [<span class="hljs-string">'Jane'</span>, <span class="hljs-number">20</span>],
    [<span class="hljs-string">'Linda'</span>, <span class="hljs-number">25</span>],
])-&gt;execute();
</code></pre>
<p>Note that the values in each row must match the corresponding column names.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#batchReplace()-detail">batchReplace</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$columns</span>, <span style="color: #0000BB">$rows</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index that new rows will be replaced.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column names</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$rows</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The rows to be batch replaced in the index</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="callKeywords()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#callKeywords()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L197" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L197" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        callKeywords()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Returns tokenized and normalized forms of the keywords, and, optionally, keyword statistics.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#callKeywords()-detail">callKeywords</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$text</span>, <span style="color: #0000BB">$fetchStatistic&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">false</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the index from which to take the text processing settings</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$text</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The text to break down to keywords.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$fetchStatistic</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>Whether to return document and hit occurrence statistics</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="callSnippets()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#callSnippets()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L182" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L182" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        callSnippets()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Builds a snippet from provided data and query, using specified index settings.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#callSnippets()-detail">callSnippets</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$source</span>, <span style="color: #0000BB">$match</span>, <span style="color: #0000BB">$options&nbsp;</span><span style="color: #007700">=&nbsp;[]</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Name of the index, from which to take the text processing settings.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$source</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Is the source data to extract a snippet from.
It could be either a single string or array of strings.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$match</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The full-text query to build snippets for.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$options</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>List of options in format: optionName =&gt; optionValue</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="checkIntegrity()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#checkIntegrity()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L330" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L330" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        checkIntegrity()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Builds a SQL command for enabling or disabling integrity check.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#checkIntegrity()-detail">checkIntegrity</a></strong> ( <span style="color: #0000BB">$check&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">true</span>, <span style="color: #0000BB">$schema&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">''</span>, <span style="color: #0000BB">$table&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">''</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$check</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>Whether to turn on or off the integrity check.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$schema</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The schema name of the tables. Defaults to empty string, meaning the current
or default schema.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table name.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-base-notsupportedexception.html">yii\base\NotSupportedException</a></td>
                  <td class="param-desc-col"><p>if this is not supported by the underlying DBMS</p>
</td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="createIndex()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#createIndex()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L306" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L306" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        createIndex()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for creating a new index.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#createIndex()-detail">createIndex</a></strong> ( <span style="color: #0000BB">$name</span>, <span style="color: #0000BB">$table</span>, <span style="color: #0000BB">$columns</span>, <span style="color: #0000BB">$unique&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">false</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$name</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the index. The name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table that the new index will be created for. The table name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column(s) that should be included in the index. If there are multiple columns, please separate them
by commas. The column names will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$unique</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>Whether to add UNIQUE constraint on the created index.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="createTable()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#createTable()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L210" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L210" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        createTable()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for creating a new DB table.</strong></p>

        <p>The columns in the new table should be specified as name-definition pairs (e.g. 'name' =&gt; 'string'),
where name stands for a column name which will be properly quoted by the method, and definition
stands for the column type which can contain an abstract DB type.
The method <span class="broken-link">yii\sphinx\QueryBuilder::getColumnType()</span> will be called
to convert the abstract column types to physical ones. For example, <code>string</code> will be converted
as <code>varchar(255)</code>, and <code>string not null</code> becomes <code>varchar(255) not null</code>.</p>
<p>If a column is specified with definition only (e.g. 'PRIMARY KEY (name, type)'), it will be directly
inserted into the generated SQL.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#createTable()-detail">createTable</a></strong> ( <span style="color: #0000BB">$table</span>, <span style="color: #0000BB">$columns</span>, <span style="color: #0000BB">$options&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the table to be created. The name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The columns (name =&gt; definition) in the new table.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$options</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Additional SQL fragment that will be appended to the generated SQL.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="dropColumn()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#dropColumn()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L250" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L250" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        dropColumn()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for dropping a DB column.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#dropColumn()-detail">dropColumn</a></strong> ( <span style="color: #0000BB">$table</span>, <span style="color: #0000BB">$column</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table whose column is to be dropped. The name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$column</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the column to be dropped. The name will be properly quoted by the method.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="dropForeignKey()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#dropForeignKey()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L298" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L298" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        dropForeignKey()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for dropping a foreign key constraint.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#dropForeignKey()-detail">dropForeignKey</a></strong> ( <span style="color: #0000BB">$name</span>, <span style="color: #0000BB">$table</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$name</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the foreign key constraint to be dropped. The name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table whose foreign is to be dropped. The name will be properly quoted by the method.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="dropIndex()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#dropIndex()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L314" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L314" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        dropIndex()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for dropping an index.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#dropIndex()-detail">dropIndex</a></strong> ( <span style="color: #0000BB">$name</span>, <span style="color: #0000BB">$table</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$name</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the index to be dropped. The name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table whose index is to be dropped. The name will be properly quoted by the method.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="dropPrimaryKey()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#dropPrimaryKey()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L282" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L282" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        dropPrimaryKey()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for removing a primary key constraint to an existing table.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#dropPrimaryKey()-detail">dropPrimaryKey</a></strong> ( <span style="color: #0000BB">$name</span>, <span style="color: #0000BB">$table</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$name</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the primary key constraint to be removed.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table that the primary key constraint will be removed from.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="dropTable()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#dropTable()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L226" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L226" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        dropTable()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for dropping a DB table.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#dropTable()-detail">dropTable</a></strong> ( <span style="color: #0000BB">$table</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table to be dropped. The name will be properly quoted by the method.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="renameColumn()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#renameColumn()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L258" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L258" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        renameColumn()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for renaming a column.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#renameColumn()-detail">renameColumn</a></strong> ( <span style="color: #0000BB">$table</span>, <span style="color: #0000BB">$oldName</span>, <span style="color: #0000BB">$newName</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table whose column is to be renamed. The name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$oldName</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The old name of the column. The name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$newName</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The new name of the column. The name will be properly quoted by the method.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="renameTable()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#renameTable()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L218" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L218" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        renameTable()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for renaming a DB table.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#renameTable()-detail">renameTable</a></strong> ( <span style="color: #0000BB">$table</span>, <span style="color: #0000BB">$newName</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table to be renamed. The name will be properly quoted by the method.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$newName</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The new table name. The name will be properly quoted by the method.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="replace()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#replace()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L99" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L99" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        replace()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates an REPLACE command.</strong></p>

        <p>For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$connection</span>-&gt;createCommand()-&gt;replace(<span class="hljs-string">'idx_user'</span>, [
    <span class="hljs-string">'name'</span> =&gt; <span class="hljs-string">'Sam'</span>,
    <span class="hljs-string">'age'</span> =&gt; <span class="hljs-number">30</span>,
])-&gt;execute();
</code></pre>
<p>The method will properly escape the column names, and bind the values to be replaced.</p>
<p>Note that the created command is not executed until <a href="yii-db-command.html#execute()-detail">execute()</a> is called.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#replace()-detail">replace</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$columns</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index that new rows will be replaced into.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column data (name =&gt; value) to be replaced into the index.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="resetSequence()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#resetSequence()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L322" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L322" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        resetSequence()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for resetting the sequence value of a table's primary key.</strong></p>

        <p>The sequence will be reset such that the primary key of the next new row inserted
will have the specified value or 1.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#resetSequence()-detail">resetSequence</a></strong> ( <span style="color: #0000BB">$table</span>, <span style="color: #0000BB">$value&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The name of the table whose primary key sequence will be reset</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$value</span></td>
                  <td class="param-type-col">mixed</td>
                  <td class="param-desc-col"><p>The value for the primary key of the next new row inserted. If this is not set,
the next new row's primary key will have a value 1.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-base-notsupportedexception.html">yii\base\NotSupportedException</a></td>
                  <td class="param-desc-col"><p>if this is not supported by the underlying DBMS</p>
</td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="truncateIndex()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#truncateIndex()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L166" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L166" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        truncateIndex()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for truncating a runtime index.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#truncateIndex()-detail">truncateIndex</a></strong> ( <span style="color: #0000BB">$index</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index to be truncated. The name will be properly quoted by the method.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="truncateTable()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#truncateTable()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L234" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L234" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        truncateTable()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates a SQL command for truncating a DB table.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#truncateTable()-detail">truncateTable</a></strong> ( <span style="color: #0000BB">$table</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$table</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The table to be truncated. The name will be properly quoted by the method.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="update()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-sphinx-command.html#update()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-sphinx/edit/master/Command.php#L154" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-sphinx/blob/master/Command.php#L154" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        update()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Creates an UPDATE command.</strong></p>

        <p>For example,</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$connection</span>-&gt;createCommand()-&gt;update(<span class="hljs-string">'user'</span>, [<span class="hljs-string">'status'</span> =&gt; <span class="hljs-number">1</span>], <span class="hljs-string">'age &gt; 30'</span>)-&gt;execute();
</code></pre>
<p>The method will properly escape the column names and bind the values to be updated.</p>
<p>Note that the created command is not executed until <a href="yii-db-command.html#execute()-detail">execute()</a> is called.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-sphinx-command.html">$this</a></span> <strong><a href="yii-sphinx-command.html#update()-detail">update</a></strong> ( <span style="color: #0000BB">$index</span>, <span style="color: #0000BB">$columns</span>, <span style="color: #0000BB">$condition&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">''</span>, <span style="color: #0000BB">$params&nbsp;</span><span style="color: #007700">=&nbsp;[]</span>, <span style="color: #0000BB">$options&nbsp;</span><span style="color: #007700">=&nbsp;[]</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The index to be updated.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$columns</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The column data (name =&gt; value) to be updated.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$condition</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The condition that will be put in the WHERE part. Please
refer to <a href="yii-db-querytrait.html#where()-detail">yii\sphinx\Query::where()</a> on how to specify condition.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The parameters to be bound to the command</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$options</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>List of options in format: optionName =&gt; optionValue</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-sphinx-command.html">$this</a></td>
                  <td class="param-desc-col"><p>The command object itself</p>
</td>
                </tr>
                                    </table>

<!--	-->
</div>
        </div>
</div>

<script type="text/javascript">
    /*<![CDATA[*/
    $("a.toggle").on('click', function () {
        var $this = $(this);
        if ($this.hasClass('properties-hidden')) {
            $this.text($this.text().replace(/Show/,'Hide'));
            $this.parents(".summary").find(".inherited").show();
            $this.removeClass('properties-hidden');
        } else {
            $this.text($this.text().replace(/Hide/,'Show'));
            $this.parents(".summary").find(".inherited").hide();
            $this.addClass('properties-hidden');
        }

        return false;
    });
    /*
     $(".sourceCode a.show").toggle(function () {
     $(this).text($(this).text().replace(/show/,'hide'));
     $(this).parents(".sourceCode").find("div.code").show();
     },function () {
     $(this).text($(this).text().replace(/hide/,'show'));
     $(this).parents(".sourceCode").find("div.code").hide();
     });
     $("a.sourceLink").click(function () {
     $(this).attr('target','_blank');
     });
     */
    /*]]>*/
</script>


</div>

<footer class="footer">
        <p class="pull-right"><small>Page generated on Sat, 09 Jul 2016 12:15:58 +0000</small></p>
    Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a></footer>

<script type="text/javascript">jQuery(document).ready(function () {
    var shiftWindow = function () { scrollBy(0, -50) };
    if (location.hash) setTimeout(shiftWindow, 1);
    window.addEventListener("hashchange", shiftWindow);
var element = document.createElement("script");
element.src = "./jssearch.index.js";
document.body.appendChild(element);

var searchBox = $('#searchbox');

// search when typing in search field
searchBox.on("keyup", function(event) {
    var query = $(this).val();

    if (query == '' || event.which == 27) {
        $('#search-resultbox').hide();
        return;
    } else if (event.which == 13) {
        var selectedLink = $('#search-resultbox a.selected');
        if (selectedLink.length != 0) {
            document.location = selectedLink.attr('href');
            return;
        }
    } else if (event.which == 38 || event.which == 40) {
        $('#search-resultbox').show();

        var selected = $('#search-resultbox a.selected');
        if (selected.length == 0) {
            $('#search-results').find('a').first().addClass('selected');
        } else {
            var next;
            if (event.which == 40) {
                next = selected.parent().next().find('a').first();
            } else {
                next = selected.parent().prev().find('a').first();
            }
            if (next.length != 0) {
                var resultbox = $('#search-results');
                var position = next.position();

//              TODO scrolling is buggy and jumps around
//                resultbox.scrollTop(Math.floor(position.top));
//                console.log(position.top);

                selected.removeClass('selected');
                next.addClass('selected');
            }
        }

        return;
    }
    $('#search-resultbox').show();
    $('#search-results').html('<li><span class="no-results">No results</span></li>');

    var result = jssearch.search(query);

    if (result.length > 0) {
        var i = 0;
        var resHtml = '';

        for (var key in result) {
            if (i++ > 20) {
                break;
            }
            resHtml = resHtml +
            '<li><a href="' + result[key].file.u.substr(3) +'"><span class="title">' + result[key].file.t + '</span>' +
            '<span class="description">' + result[key].file.d + '</span></a></li>';
        }
        $('#search-results').html(resHtml);
    }
});

// hide the search results on ESC
$(document).on("keyup", function(event) { if (event.which == 27) { $('#search-resultbox').hide(); } });
// hide search results on click to document
$(document).bind('click', function (e) { $('#search-resultbox').hide(); });
// except the following:
searchBox.bind('click', function(e) { e.stopPropagation(); });
$('#search-resultbox').bind('click', function(e) { e.stopPropagation(); });

});</script></body>
</html>
